.. _`Merge Table`:

.. _`org.sysess.data.table.mergetable`:

Merge Table
```````````

.. image:: merge.svg
   :width: 48


Merge Tables while matching an Index




Documentation
:::::::::::::

Internally uses `pandas.DataFrame.merge
<https://pandas.pydata.org/pandas-docs/
stable/generated/pandas.DataFrame.merge.html>`_. For more information see
that documentation.

Essentially, this node calls:

.. code-block:: python

    pandas.merge(
        input_a, input_b, how=join_operation,
        on=index_column)

Values for Join Operation are:

    - Union, similar to SQL full outer join
    - Intersection, similar to SQL inner join
    - Index from A, similar to SQL left outer join
    - Index from B, similar to SQL right outer join


Definition
::::::::::


Input ports
...........

    **Input A**  table
        Input A

    **Input B**  table
        Input B


Output ports
............

    **Output**  table
        Output




Configuration
.............

    **Index column** (index)
        Column with indices to match
    **Join operation** (operation)
        Column with y values.







Examples
........

* :download:`MergeTable.syx </_examples/Sympathy/Data Processing/Structure/MergeTable.syx>`



Implementation
..............

.. automodule:: node_merge_tables
    :noindex:

.. class:: MergeTable
    :noindex: